Skip to content

docs(sphinx): preserve domain terms and clean reference docs warnings#1401

Open
jaelliot wants to merge 3 commits intoWebOfTrust:mainfrom
jaelliot:chore/docstrings-routing-only
Open

docs(sphinx): preserve domain terms and clean reference docs warnings#1401
jaelliot wants to merge 3 commits intoWebOfTrust:mainfrom
jaelliot:chore/docstrings-routing-only

Conversation

@jaelliot
Copy link
Copy Markdown
Contributor

Summary

  • preserve canonical KERI domain terminology in Sphinx output by handling reference policy in docs/conf.py
  • add doc guidance explaining that unresolved domain references should be handled in config instead of renaming terms
  • clean a small set of reference-doc warnings in getting_started.md, Peer2PeerCredentials.md, and tel.md

Why this boundary

This PR is a docs/Sphinx configuration unit that stands on its own. It does not depend on the unstaged Python docstring work in the local worktree.

Validation

  • ran strict docs build locally: sphinx-build -n --keep-going -b dirhtml . _build/dirhtml
  • verified the build exited 0
  • confirmed the reviewed doc files no longer appeared in the filtered warning checks used during cleanup

Out of scope

  • broader docstring cleanup across Python modules
  • pre-existing docutils warnings in src/ docstrings
  • unrelated unstaged Python edits present only in the local worktree

Notes

This PR intentionally preserves KERI domain language rather than rewriting terminology to satisfy Sphinx cross-reference resolution.

- narrow the branch to routing.py only to preserve docstrings-only scope
- keep the change limited to documentation formatting for easier review
- preserve the broader mixed-scope cleanup separately on the original feature branch
Copilot AI review requested due to automatic review settings April 15, 2026 00:15
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants